home *** CD-ROM | disk | FTP | other *** search
/ Shareware Super Platinum 8 / Shareware Super Platinum 8.iso / mac / WIN_PRO / QDHLP201.ZIP;1 / WHATSNEW.DOC < prev   
Encoding:
Text File  |  1992-08-05  |  7.1 KB  |  200 lines
  1. Welcome to QDHELP version 2.0
  2.  
  3. This file contains information on what new features and fuctionality
  4. have been added to QDHELP.  Also found here are any known problems
  5. with backward compatibility. 
  6.  
  7. New Fuctionality included in this release:
  8.  
  9. -----------------------------------------------------------------------
  10.  
  11. output file name change:  
  12.  
  13. The default for the output file name is no
  14. longer out.rtf.  If no output file name is given explicitly the 
  15. output file will have the same base name as the input file with the
  16. extention .rtf added.  Example input is myhelp.qdh default output 
  17. will now be myhelp.rtf.
  18.  
  19. -----------------------------------------------------------------------
  20.  
  21. color text commands:  
  22.  
  23. Text can now be colored using the \cfXXX command
  24. where XXX is an index between 0 and 15 which determines the color of
  25. the text.  The included windows help file shows the colors.
  26.  
  27. -----------------------------------------------------------------------
  28.  
  29. auto generation of .hpj file:  The .hpj    file will use the same base name 
  30.  
  31. as the input file with a extension .hpj . To suppress the output of the
  32. .hpj file use the command
  33. /pragma nohpj
  34.  
  35. -----------------------------------------------------------------------
  36.  
  37. auto generation of include file for context sensitive help:  
  38.  
  39. QDHELP will automatically generate a C header file with constants
  40. for context sensitive help. The file will use the same base name as
  41. the input file with a extension of .hhh. This file can be included
  42. in the .hpj file (if you are generating a .hpj and a .hhh file the 
  43. include will automatically be put in your .hpj file).  It can also be
  44. included in your C source via the #include directive.
  45.  
  46.  
  47. -----------------------------------------------------------------------
  48.  
  49. format type for whole document:  
  50.  
  51. A new command /defformat will accept
  52. both paragraph and text formatting commands.  If this command is used
  53. outside a topic this will be the base format for all text in the 
  54. document.  All other formatting commands are applied after the default
  55. format commands.  If this command is found inside a topic all the 
  56. text in the topic will use these as there base formatting commands.
  57. When the topic ends so  does the use of the /defformat command found
  58. inside the topic.
  59.  
  60. -----------------------------------------------------------------------
  61.  
  62. format type for whole para: 
  63.  
  64. The \para command now allows formatting
  65. commands for text to be included after it.  This will cause all the
  66. text in that paragraph to use those formatting properties. 
  67.  
  68. -----------------------------------------------------------------------
  69.  
  70. support for buildtags:  
  71.  
  72. The /topic command now arguments after the topic name.  
  73. They are buildtag names
  74.  
  75. Example
  76. /topic MYTOPIC,BUILD1;BUILD2;BUILD3
  77. This sets build tabs BUILD1,BUILD2 and BUILD3 for topic MYTOPIC.  The use
  78. of the build tabs is described in the help compiler manual.  If you are
  79. using the -j flag and generating a .hpj file the build tags will 
  80. automatically be put into the .hpj file for you.  Also the BUILD option
  81. in the [OPTIONS] section will be set to the OR of all of the build tags
  82. found
  83. BUILD = BUILD1 | BUILD2 | BUILD3
  84. This will cause all of the topics in the file to be built.  You can 
  85. of course change what will be built by changing the BUILD option.
  86.  
  87.  
  88. -----------------------------------------------------------------------
  89.  
  90. force a newline: (HC3.1 WinHelp 3.1) 
  91.  
  92. Microsoft fixed the help compiler so it understands the \line command
  93. now.  So to put newlines into the help file do the following
  94.  
  95. Example
  96.  
  97. /para
  98.     line 1 \line
  99.     line 2 \line
  100.     line 3 \line
  101.     line 4 \line
  102. /endpara
  103.  
  104. This will only work with the new help compiler and anything compiled
  105. with the new help compiler can only be used with the new version of
  106. WinHelp.
  107.  
  108. -----------------------------------------------------------------------
  109.  
  110. support macro links: (HC3.1 WinHelp 3.1)
  111.  
  112. The Windows 3.1 release has alot of new power in the help engine.
  113. QDHELP supports the new macro links (i.e. links the instead of
  114. jumping to a topic execute a macro command).  The syntax is
  115.  
  116. /macrolink link text,macro
  117.  
  118. where link text is the text to press and macro is the macro to execute
  119. when link text is pressed.
  120.  
  121. ------------------------------------------------------------------------
  122.  
  123. support topic macros: (HC3.1 WinHelp 3.1)
  124.  
  125. The Windows 3.1 release allows macros to be executed when a topic is
  126. jumped to.  This is supported via the /topicmacro command.
  127.  
  128. The /topicmacro command is grouped with the /keywords /browse /title
  129. commands at the beginning of a topic.  Its syntax is
  130.  
  131. /topicmacro macro
  132.  
  133. Where macro is a macro that you want executed when the topic you are
  134. defining is jumped to.
  135.  
  136. ------------------------------------------------------------------------
  137.  
  138. support for .HPJ file inputs:
  139.  
  140. Since QDHELP 2.0 supports automatic generation of .HPJ files there is
  141. a whole set of commands that allow you to add information to the .HPJ
  142. file.  These commands were added so that you do not have to manually
  143. edit the .HPJ file.  In this way you can keep all the information you
  144. need for your help file in one place.  The following commands were
  145. added.
  146.  
  147. /hpjmap
  148. /hpjoption
  149. /hpjconfig
  150. /hpjbuild
  151. /hpjfiles
  152. /hpjbitmap
  153. /hpjalias
  154. /hpjwindows
  155. /hpjbaggage
  156.  
  157.  
  158. These commands are the same as the sections of the .HPJ file under windows
  159. 3.1.  You can find more information on each of these commands in the
  160. accompaning help file.
  161.  
  162. --------------------------------------------------------------------------
  163.  
  164. New help file layout:
  165.  
  166. The source for the help files for QDHELP and QDMENU have been broken into
  167. multiple files.  If you choose to work in this method using the /include
  168. command to gather all the files together you may be interested in the new
  169. browse capability added for Win 3.1 users.  The command
  170. /pragma debug 
  171. causes a new button to be added to the help window labeled Browse.  If you
  172. press browse ,and you ran the help file from the directory which contains the
  173. .QDH source, a notepad will pop up with the source file for the given topic
  174. in it.  It is a very nice way to check and edit your help file.  Try it
  175. you will like it.
  176.  
  177. --------------------------------------------------------------------------
  178.  
  179. Be sure to check the help file included and the source for the help file
  180. since there is much that is new and the best way to learn about is by
  181. example.
  182.  
  183. --------------------------------------------------------------------------
  184.  
  185. Backward compatiblity Issues:
  186.  
  187. None of the Win 3.1 additions to help will be able to be compiled under the
  188. HC 3.0 help compiler.  This is the compiler that is still shipping with 
  189. the Profession Toolkit for basic.  You will need the 3.1 help compiler
  190. to take advantage of these features.  But remember that help files compiled
  191. with the 3.1 help compiler are not useable by the 3.0 WinHelp program.
  192. Therefore if someone is still running windows 3.0 and your help file is
  193. for 3.1 there could be problems.
  194.  
  195. --------------------------------------------------------------------------
  196.  
  197. Keep making help the quick and dirty way!
  198.  
  199. Phil Allen
  200.